<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>avwait: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-avdtpsrc.html" title="avdtpsrc">
<link rel="next" href="gst-plugins-bad-plugins-bayer2rgb.html" title="bayer2rgb">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-avwait.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-avwait.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-avwait.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-plugins-avdtpsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-plugins-bayer2rgb.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-plugins-avwait"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-avwait.top_of_page"></a>avwait</span></h2>
<p>avwait</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWaitMode" title="enum GstAvWaitMode"><span class="type">GstAvWaitMode</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait--target-running-time" title="The “target-running-time” property">target-running-time</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstVideo.html#GstVideoTimeCode"><span class="type">GstVideoTimeCode</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait--target-timecode" title="The “target-timecode” property">target-timecode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait--target-timecode-string" title="The “target-timecode-string” property">target-timecode-string</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstVideo.html#GstVideoTimeCode"><span class="type">GstVideoTimeCode</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait--end-timecode" title="The “end-timecode” property">end-timecode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait--recording" title="The “recording” property">recording</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstAvWait"></a><div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWait-struct" title="struct GstAvWait">GstAvWait</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWaitMode" title="enum GstAvWaitMode">GstAvWaitMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> GstAvWait
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.description"></a><h2>Description</h2>
<p>This element will drop all buffers until a specific timecode or running
time has been reached. It will then pass-through both audio and video,
starting from that specific timecode or running time, making sure that
audio starts as early as possible after the video (or at the same time as
the video). In the "video-first" mode, it only drops audio buffers until
video has started.</p>
<p>The "recording" property acts essentially like a valve connected before
everything else. If recording is FALSE, all buffers are dropped regardless
of settings. If recording is TRUE, the other settings (mode,
target-timecode, target-running-time, etc) are taken into account. Audio
will always start and end together with the video, as long as the stream
itself doesn't start too late or end too early.</p>
<div class="refsect3">
<a name="id-1.2.21.7.4"></a><h4>Example launch line</h4>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> filesrc location<span class="gtkdoc opt">=</span><span class="string">&quot;my_file&quot;</span> <span class="gtkdoc opt">!</span> decodebin name<span class="gtkdoc opt">=</span>d <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw&quot;</span> <span class="gtkdoc opt">!</span> avwait name<span class="gtkdoc opt">=</span>l target<span class="gtkdoc opt">-</span>timecode<span class="gtkdoc opt">-</span>str<span class="gtkdoc opt">=</span><span class="string">&quot;00:00:04:00&quot;</span> <span class="gtkdoc opt">!</span> autoaudiosink d<span class="gtkdoc opt">. !</span> <span class="string">&quot;video/x-raw&quot;</span> <span class="gtkdoc opt">!</span> timecodestamper <span class="gtkdoc opt">!</span> l<span class="gtkdoc opt">.</span> l<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> timeoverlay time<span class="gtkdoc opt">-</span>mode<span class="gtkdoc opt">=</span>time<span class="gtkdoc opt">-</span>code <span class="gtkdoc opt">!</span> autovideosink</pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.21.7.5.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-bad-plugins-plugin-timecode.html#plugin-timecode">timecode</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Vivia Nikolaidou &lt;vivia@toolsonair.com&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Audio/Video</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.21.7.5.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>asink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/x-raw</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>vsink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>asrc</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>audio/x-raw</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>vsrc</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstAvWait-struct"></a><h3>struct GstAvWait</h3>
<pre class="programlisting">struct GstAvWait;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstAvWaitMode"></a><h3>enum GstAvWaitMode</h3>
<div class="refsect3">
<a name="GstAvWaitMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="MODE-TIMECODE:CAPS"></a>MODE_TIMECODE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="MODE-RUNNING-TIME:CAPS"></a>MODE_RUNNING_TIME</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="MODE-VIDEO-FIRST:CAPS"></a>MODE_VIDEO_FIRST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-avwait.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstAvWait--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting">  “mode”                     <a class="link" href="gst-plugins-bad-plugins-avwait.html#GstAvWaitMode" title="enum GstAvWaitMode"><span class="type">GstAvWaitMode</span></a></pre>
<p>Operation mode: What to wait for.</p>
<p>Flags: Read / Write</p>
<p>Default value: time code (default)</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAvWait--target-running-time"></a><h3>The <code class="literal">“target-running-time”</code> property</h3>
<pre class="programlisting">  “target-running-time”      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>Running time to wait for in running-time mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: 18446744073709551615</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAvWait--target-timecode"></a><h3>The <code class="literal">“target-timecode”</code> property</h3>
<pre class="programlisting">  “target-timecode”          <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstVideo.html#GstVideoTimeCode"><span class="type">GstVideoTimeCode</span></a> *</pre>
<p>Timecode to wait for in timecode mode (object).</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAvWait--target-timecode-string"></a><h3>The <code class="literal">“target-timecode-string”</code> property</h3>
<pre class="programlisting">  “target-timecode-string”   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Timecode to wait for in timecode mode (string). Must take the form 00:00:00:00.</p>
<p>Flags: Read / Write</p>
<p>Default value: "00:00:00:00"</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAvWait--end-timecode"></a><h3>The <code class="literal">“end-timecode”</code> property</h3>
<pre class="programlisting">  “end-timecode”             <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstVideo.html#GstVideoTimeCode"><span class="type">GstVideoTimeCode</span></a> *</pre>
<p>Timecode to end at in timecode mode (object).</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GstAvWait--recording"></a><h3>The <code class="literal">“recording”</code> property</h3>
<pre class="programlisting">  “recording”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the element is stopped or recording. If set to FALSE, all buffers will be dropped regardless of settings.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>